<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: D:/Projects/MiXiM/extsrc/mixim/src/base/modules/BaseModule.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00272.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">BaseModule.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode:c++ -*- ********************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * file:        BaseModule.h</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * author:      Steffen Sroka</span>
<a name="l00005"></a>00005 <span class="comment"> *              Andreas Koepke</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * copyright:   (C) 2004 Telecommunication Networks Group (TKN) at</span>
<a name="l00008"></a>00008 <span class="comment"> *              Technische Universitaet Berlin, Germany.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> *              This program is free software; you can redistribute it</span>
<a name="l00011"></a>00011 <span class="comment"> *              and/or modify it under the terms of the GNU General Public</span>
<a name="l00012"></a>00012 <span class="comment"> *              License as published by the Free Software Foundation; either</span>
<a name="l00013"></a>00013 <span class="comment"> *              version 2 of the License, or (at your option) any later</span>
<a name="l00014"></a>00014 <span class="comment"> *              version.</span>
<a name="l00015"></a>00015 <span class="comment"> *              For further information see file COPYING</span>
<a name="l00016"></a>00016 <span class="comment"> *              in the top level directory</span>
<a name="l00017"></a>00017 <span class="comment"> ***************************************************************************</span>
<a name="l00018"></a>00018 <span class="comment"> * part of:     framework implementation developed by tkn</span>
<a name="l00019"></a>00019 <span class="comment"> **************************************************************************/</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef BASE_MODULE_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define BASE_MODULE_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;sstream&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;omnetpp.h&gt;</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="preprocessor">#include &quot;MiXiMDefs.h&quot;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;HostState.h&quot;</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef debugEV</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define debugEV_clear (ev.isDisabled()||!debug) ? ev : ev</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define debugEV (ev.isDisabled()||!debug) ? ev : ev &lt;&lt; logName() &lt;&lt; &quot;::&quot; &lt;&lt; getClassName() &lt;&lt; &quot;: &quot;</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef coreEV</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define coreEV_clear (ev.isDisabled()||!coreDebug) ? ev : ev</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define coreEV (ev.isDisabled()||!coreDebug) ? ev : ev &lt;&lt; logName() &lt;&lt; &quot;::&quot; &lt;&lt; getClassName() &lt;&lt;&quot;: &quot;</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00072"></a><a class="code" href="a00027.html">00072</a> <span class="keyword">class </span>MIXIM_API <a class="code" href="a00027.html" title="Base class for all simple modules of a host.">BaseModule</a>: <span class="keyword">public</span> cSimpleModule, <span class="keyword">public</span> cListener {
<a name="l00073"></a>00073   <span class="keyword">protected</span>:
<a name="l00075"></a><a class="code" href="a00027.html#af32711ea117b066fcd10081a17bb81d4">00075</a>     <span class="keywordtype">bool</span> <a class="code" href="a00027.html#af32711ea117b066fcd10081a17bb81d4" title="Debug switch for all other modules.">debug</a>;
<a name="l00076"></a>00076 
<a name="l00080"></a><a class="code" href="a00027.html#ad2e5c785ee5b988e624a11a9b80e2bce">00080</a>     <span class="keywordtype">bool</span> <a class="code" href="a00027.html#ad2e5c785ee5b988e624a11a9b80e2bce" title="Stores if this module is affected by changes in the hosts state. If not explicitly set this module ha...">notAffectedByHostState</a>;
<a name="l00081"></a>00081 
<a name="l00083"></a><a class="code" href="a00027.html#a0d89757df3cc2bf55649eee85aad6402">00083</a>     <span class="keyword">const</span> <span class="keyword">static</span> <a class="code" href="a00201.html" title="Helper function to initialize signal change identifier on use and not on initializing static sections...">simsignalwrap_t</a> <a class="code" href="a00027.html#a0d89757df3cc2bf55649eee85aad6402" title="Stores the category of the HostState.">catHostStateSignal</a>;
<a name="l00084"></a>00084 <span class="keyword">protected</span>:
<a name="l00085"></a>00085 
<a name="l00095"></a>00095     <span class="keyword">virtual</span> <span class="keywordtype">void</span> handleHostState(<span class="keyword">const</span> <a class="code" href="a00098.html" title="HostState is published by the battery to announce host failure.">HostState</a>&amp; state);
<a name="l00096"></a>00096 
<a name="l00104"></a>00104     <span class="keywordtype">void</span> switchHostState(<a class="code" href="a00098.html#a5002302e0f07bbd982c6e5d65eaa9c3c" title="Possible host states.">HostState::States</a> state);
<a name="l00105"></a>00105 
<a name="l00107"></a>00107     cModule* findHost(<span class="keywordtype">void</span>);
<a name="l00108"></a>00108     <span class="keyword">const</span> cModule* findHost(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00110"></a>00110     <span class="comment">//std::string getLogName(int);</span>
<a name="l00111"></a>00111 
<a name="l00112"></a>00112 <span class="keyword">private</span>:
<a name="l00115"></a>00115     <a class="code" href="a00027.html" title="Base class for all simple modules of a host.">BaseModule</a>(<span class="keyword">const</span> <a class="code" href="a00027.html" title="Base class for all simple modules of a host.">BaseModule</a>&amp;);
<a name="l00118"></a>00118     <a class="code" href="a00027.html" title="Base class for all simple modules of a host.">BaseModule</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="a00027.html" title="Base class for all simple modules of a host.">BaseModule</a>&amp;);
<a name="l00119"></a>00119 
<a name="l00120"></a>00120   <span class="keyword">public</span>:
<a name="l00121"></a>00121 
<a name="l00122"></a>00122     <a class="code" href="a00027.html" title="Base class for all simple modules of a host.">BaseModule</a>();
<a name="l00123"></a>00123     <a class="code" href="a00027.html" title="Base class for all simple modules of a host.">BaseModule</a>(<span class="keywordtype">unsigned</span> stacksize);
<a name="l00124"></a>00124 
<a name="l00126"></a>00126     <span class="keyword">virtual</span> <span class="keywordtype">void</span> initialize(<span class="keywordtype">int</span>);
<a name="l00127"></a>00127 
<a name="l00140"></a><a class="code" href="a00027.html#ace4692f0eb43b2d4ca4e46f81b5c77a1">00140</a>     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="a00027.html#ace4692f0eb43b2d4ca4e46f81b5c77a1" title="Divide initialization into two stages.">numInitStages</a>()<span class="keyword"> const </span>{
<a name="l00141"></a>00141       <span class="keywordflow">return</span> 2;
<a name="l00142"></a>00142     }
<a name="l00143"></a>00143 
<a name="l00151"></a>00151     std::string logName(<span class="keywordtype">void</span>) <span class="keyword">const</span> ;
<a name="l00152"></a>00152 
<a name="l00156"></a><a class="code" href="a00027.html#af7e5a2e34b218afcc9b92d75e5e11df8">00156</a>     <span class="keyword">const</span> cModule* <a class="code" href="a00027.html#af7e5a2e34b218afcc9b92d75e5e11df8" title="Get a reference to the local node module.">getNode</a>()<span class="keyword"> const </span>{
<a name="l00157"></a>00157       <span class="keywordflow">return</span> findHost();
<a name="l00158"></a>00158     }
<a name="l00159"></a>00159 
<a name="l00166"></a>00166     <span class="keyword">virtual</span> <span class="keywordtype">void</span> receiveSignal(cComponent *source, simsignal_t signalID, cObject *obj);
<a name="l00167"></a>00167 };
<a name="l00168"></a>00168 
<a name="l00169"></a>00169 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>BaseModule.h</b>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:29 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
